Night Owl 6

home *** CD-ROM | disk | FTP | other *** search

/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 025a / bibl551b.zip / BIBL.DOC next >

Wrap

Text File | 1991-10-01 | 63KB | 1,529 lines

B I B L release 5.51 (c) 1991, Clyde W. Grotophorst GMUtant Software Route 1, Box 296 Hamilton, Virginia 22068 U.S.A. This documentation covers both the SHAREWARE and REGISTERED versions of the package. An [R] appears in the left margin when a registered-version-only feature is discussed. Non-registered users of this software are granted a limited license to make an evaluation copy for trial use on a private, non-commercial basis, for the express purpose of determining whether BIBL meets their needs. At the end of this trial period, (30 days) you should either register your copy or discontinue use. Registration licenses you to use the product on a regular basis. Registration also provides you with access to the GMUtant Online BBS ((703) 993-2219) as a registered user--where you may receive support, leave questions, requests for enhancements, or download the latest release of the program. The registered version offers expanded capabilities. Registering BIBL will also allow you to download special programs from the GMUtant OnLine BBS--for example, BIBL286 is a version of BIBL using machine code for the 80286 or 80386 processor. This allows BIBL to take better advantage of these CPUs and creates a slightly smaller BIBL.EXE file. BGC, another add on program, is a global 'find & replace' utility that lets you change the text in all records of any BIBL databases. Registration requires a contribution of $ 25.00 to the author, as a reimbursement for the time spent working on this program. Once you have registered, you will be given a registration number. You may 'upgrade' your SHAREWARE version to REGISTERED by entering that number into BIBL (via CONVERT on the maintenance menu). By using this method, you may instantly upgrade any subsequent release without having to call our BBS to download the file. If you have registered a previous version of BIBL, you are also a registered user of any subsequent version. You may upgrade at any time by sending $ 4.00 to the address below. The latest version will be sent. Send your name, address and registration payment to: Clyde W. Grotophorst Route 1, Box 296 Hamilton, Virginia 22068 ** CREDIT CARD ORDERS ** You may also order the registered version of BIBL from Public (software) Library with your MasterCard, Visa, American Express, or Discover Card by calling 800-2424-PSL or 713-524-6394 or by FAX to 713-524-6398, or by CompuServe to 71355,470 or by mail to PsL, P.O. Box 35705, Houston, Texas 77235-5705. These numbers are for ordering only. The cost is $ 29.00 which includes a copy of the latest registered version to you by return 1st class mail. -2- We've included sample records with BIBL for demonstration purposes. The sample database and index are inside BIBLDEMO.EXE Type BIBLDEMO at the DOS prompt to extract these files. You may delete DEMO.DAT and DEMO.IX when you are ready to begin entering information you want to keep. To see the sorts of things included in the sample file, and to study how you might use the fields in a BIBL record, activate BIBL then press L, the last record in the file will display. Press [B] to move backward through the file. Q U I C K S T A R T Copy BIBL.EXE to a sub-directory on your disk (e.g., C:\BIBL) then type BIBL to activate the program. If you have not extracted the demo database, enter the name of the database you want to create. If you want to use the sample database instead of beginning with an empty one, type B5DEMO before running BIBL. This will extract the demonstration files (DEMO.DAT and DEMO.IX). BIBL Features [SHAREWARE and REGISTERED]: - an unlimited number of databases are supported. - more records from one database to another - menu-driven. - mouse-support for most areas of the program. - easily understood user interface (bounce-bar menus or accepts first letter of each command). - five indexes are maintained (in a single file) for fast retrieval and sorted extracts (author, author/title, title, subject, and descriptor). - up to 8 words from the descriptor field are indexed individually. - produces bibliographies in several forms (brief, annotated, full (and with registered version labelled), full) based on information in any field. Each bibliography is sorted by author, then within author, by title. - user-selected fields for output (soft return option available). - when no match is made on an indexed search, BIBL displays where in the index your query would have appeared (near misses). - produces a wide variety of lists (in ASCII form) which may be printed or edited with any word-processor that accepts ASCII files for input. - if desired, BIBL will run in a 'read-only' mode. This allows copies of your database to be accessed by the public but protects against editing, deleting or otherwise modifying the database. - BIBL offers an ASCII file viewer that supports a mouse, and is moveable, resizeable, and ZOOMable. - BIBL reserves memory (heap) for indexes in a dynamic fashion--improving retrieval speed. - Index graph shows progress as indexing/reindexing occurs - ability to print or save to disk any individual record. - main menu screen always reports active database and number of records in that file. -3- - empty records (e.g., after deletions) are used as new records are added. - BIBL shells out to PKZIP, LHA or ARJ to create compressed backup copies of your database. BIBL will find the compression utility if it exists ANYWHERE on your DOS path. - Boolean OR and AND searching supported for ALL fields. - Selected reports (list of subjects, list of titles, etc) may be viewed onscreen and/or sent to disk. - BIBL can produce a comma-delimited file of the database. This allows import to dBASE or other DBMS packages. - any ASCII file may be used for display when I (INFORMATION) is pressed on the main menu. - Shell to DOS (uses heap compression to free as much memory as possible). - Install editor/viewer. Allows user to install an external program for use as the editor/viewer under File Maintenance options. The REGISTERED version adds these features: - A larger percentage of free RAM is devoted to in-memory index storage (40% of RAM remaining after BIBL is loaded). This greatly speeds retrieval and reduces disk I/O for larger databases. - External editor. The registered version uses advanced memory management to swap most of BIBL out of memory (to disk or EMS if available) during this process, allowing use of very large programs (e.g., WordPerfect 5.1) as the editor. BIBL shrinks to a 60K kernel in memory, all other RAM is devoted to your second application. - Using the "LABELLED" output option under BIBLIOGRAPHIES, you may create an ASCII (*. BIX) file of records suitable for import to other databases via the ASCII Import option on the Maintenance menu. Using this method you also have the option of deleting exported records from your original file as they transfer. - Bibliographies (option D under EXPORT) as well as other reports may be created in 'word-processing' form (this will put soft returns in your file within a given citation, hard returns between them). This makes it much easier to do subsequent editing of your bibliography with a word processor. - Bibliographies. Registered version supports export of records based on ANY field in the record, not just Author, Publisher, Subject, or Descriptor. - Store Datafiles and Indexes (*.DAT and *.IX) on another drive or in another subdirectory. This enables you to use BIBL on remote disks if desired (e.g., on a LAN). - Global Find & Replace for text in any field across any database. - BIBL will run in 43/50 line mode. -4- I N S T A L L A T I O N Copy BIBL.EXE and BIBL.DOC to a sub─directory. If you want to experiment with the sample database we provide, copy BIBLDEMO.EXE to this sub-directory as well. Type BIBLDEMO at the DOS prompt to extract the demostration files, then type BIBL to activate the program. After you have experimented with the capabilities of BIBL using the demo database, delete DEMO.DAT and the DEMO.IX file. When you next activate BIBL, you will have the opportunity to create a new (empty) database. Be sure your CONFIG.SYS file contains the following minimum values: FILES=20, BUFFERS=20. To find out whether your machine has a CONFIG.SYS file, issue the following commands: PROMPT $P$G [press return. You may already be using this prompt string, but if not, at least from here on out you will know what drive and sub-directory you are defaulting to.] C: [press return...we want to log onto the C: drive] CD\ [press return, this should put us in the root directory] a 'C:\>' prompt should appear. If so, type the following command: DIR C*.SYS [press return] If you do not see a file named CONFIG.SYS in the newly displayed text, you can safely assume that one does not exist. To Create CONFIG.SYS: Issue the following commands at C:\> prompt (to be a bit more technical, while logged onto the root directory of the boot drive (typically C:) of your system): Copy Con: CONFIG.SYS [press return] FILES=20 [press return] BUFFERS=20 [press F6] You should receive a '1 file copied.' message. Reboot your computer. The CONFIG.SYS file is read only during initial boot of your system. Questions about this can be resolved by looking at your DOS manual. -5- S Y S T E M O V E R V I E W BIBL (rhymes with nibble) is a simple to use online catalog for your personal library. Written in Turbo Pascal 6.0 and using full B-tree indexing (thanks to TurboPower's B-Tree Filer package), the system is fast, small, and very efficient. Menu-driven, BIBL can be used to track your book collection, article reprints, index your vertical file, manage a small office library, and so on... In most areas bounce-bar menus are used. To select a particular option, move the bar via the cursor until your desired operation is highlighted, then press RETURN. If you're a touch typist, you might prefer pressing the highlighted letter within (or just to the left of) the choice you wish to make (e.g., Press S to activate SEARCH on the main menu). On single line menus (e.g., when displaying matches), you may hit the highlighted letter to execute the command, or move between them via the TAB key. Clicking a mouse on your menu choice will also activate it. Command Line Switches ( /p or /m or /v ) If on a monochrome monitor you find you can not clearly read the various BIBL status line displays, activate program with an '/m' switch (for mono), e.g., BIBL /M <cr>. OPAC (Online Public Access Catalog) . If you want to have others use your BIBL database but don't want them adding, deleting, or editing records, begin BIBL with the /p switch. This activates OPAC mode, disabling writing to your database. You may use both the mono and opac switches, or just one. To use both you would begin BIBL with the following command line: BIBL /m /p <cr> [R] BIBL will also run in 43 or 50 line mode (EGA or VGA) if you [R] start the program with a /v switch. BIBL will automatically [R] detect the resident hardware and make the appropriate setting. [R] Upon exit, the 25 line mode will be restored. If you use [R] WordPerfect 5.1 as your installed editor/viewer, and are [R] BIBL in the 43/50 line mode, your call to WordPerfect will [R] switch that package into 43/50 line mode as well. -6- OPENING MENU When you type BIBL at the DOS prompt, several things happen... 1) the program allocates RAM for in-memory storage of the indexes. The SHAREWARE version sets aside 20K, the REGISTERED version uses 40% of available RAM. 2) if you are using the SHAREWARE version, a reminder to register screen appears (actually appears about 50% of the time). 3) the program next checks your disk to see how many *.DAT files can be found... a) Only one, the program opens that database. b) More than one, a pick-list appears. You select the file you want to use by moving the light bar with the cursor arrows until the desired database is highlighted--then press RETURN. If you have a mouse, double-click on the desired file. 4) The main menu appears. Main Menu Options L List items in the database. This option allows you to move through the database a record at a time. The records appear in the order in which they were entered into the system. Pressing L on the main menu takes you to the last record in the file (the assumption being that you are probably more interested in the more recent records). You may move about the file via the J (Jump) command--which 'jumps' you to the record number you enter. A Add an item to the file. Use for entering data into a database. S Search a database. Supports a variety of search types. E Export data. Enables user to produce a variety of reports, including bibliographies. V View ASCII file(s). Allows user to look at an ASCII file. If you are using the registered version, and have installed a word processing program (e.g., WordPerfect) as your external editor/viewer, then pressing V calls that program and passes the name of the file to view. M Maintenance functions. This function provides a variety of support operations (rebuilding indexes, creating new databases, deleting databases, Shell to DOS, etc.). D Database selection. Once you have created a second database, this function allows you to move between database files. I Information on BIBL. Pressing I on the Main Menu causes the file BIBL.HLP to display in a window on your screen. If you want to create your own help file, just create an ASCII file and give it the name BIBL.HLP. You don't have to worry about page breaks or other formatting (although it will work best if you don't exceed 75 characters in a line. Q Quit to DOS. Closes all files, halts program and exits. -6- DATABASES BIBL can manage a number of distinct databases. While the structure of each database is the same, you may have several--enabling you to separate out records that belong together. Each 'database' consists of two files (*.DAT and *.IX). You create empty databases from the Maintenance sub-menu. Once created, you may select (or activate) a particular database via the Database Selection option on the main menu. I. ADDING RECORDS TO A DATABASE Each database is limited to 2 billion records although you'll run out of disk space long before that becomes an issue. To begin working toward that 2 billion, press A as the main menu is displayed. A blank record will appear on the screen. Enter data in the highlighted fields. If you want to skip a field, just press RETURN when the cursor is inside that field's highlighted box. When you are finished, either press return when the highlighted box is in line 7 of the note field, or press ESC. BIBL will then offer a prompt line at the bottom of the screen. Asking to either file the record, continue editing it, or abandoning the whole record. You may click the appropriate response with your mouse or enter the highlighted first letter of the option you desire (e.g., A to Abandon). [Y] Yes, file record. This will add the record to the database and update the index file (unless all fields in the record are empty, in which case the command to file is ignored). [N] No, edit Record. This returns the cursor to the first field of the record, allowing you to continue editing the information. [A] Abandon. This abandons the information and returns you to the main menu. BIBL INDEXING Five indexes are maintained in the single file: 1) the first 20 characters of the author field, 25 characters of the TITLE field, the entire SUBJECT field, each word (something with a space before and after it) of the DESCRIPTOR field (must be more than a single character), and a fifth index used to create temporary sorts (by call number, author/title, etc.). Information is stored in upper case in the index file and your query is converted to upper case before a search begins--thus you don't have to worry about capitalization (although the way you enter data is the way it will display and appear in any ASCII file created by BIBL. -7- FIELDS (Subject vs Descriptor): Most fields are obvious, but you might not be familiar with the distinction we're making between subject and descriptors. Put the most important term in the subject field and other less useful but desired descriptive terms in the DESC: field. The DESCRIPTOR field uses a keyword index--wherein each word of the field is indexed. Caution: No word in the descriptor field can be longer than 20 characters (or it will be truncated to 20 characters in the index). The indexing algorithm considers a word to be anything between two blank spaces. If you have a compound term, include a '-' between the words so they'll be considered a single term (e.g., 'World-War-II' is considered 1 term while 'World War II' is three.). Up to 8 words in any one DESC field will be indexed. A single letter WILL NOT be indexed. Each 'word' must be longer than one character. CLASSIFICATION: Use the classification field for whatever you like but we envision it storing things like 'Book',' Journal Article', 'Review article', 'Newspaper' and so on. If you use a numbering scheme (e.g., LC Call numbers) then that information could be stored there (as could location information). There are two ways under the EXPORT sub-menu to produce a report sorted on Classification number: Option [L] (4/1/2) and/or option [M] (User-Defines). II. SEARCHING THE DATABASE To search, press S at the main menu, then via the light bar select which field you wish to search (Author, Title, Subject, Note, etc.). Once you have selected the field you wish to search, a 'QUERY' box will appear. Enter the text you wish to locate in this box, at the 'Query >>' prompt. You may search text in ANY field of a BIBL record. Matches are made using your input as a stem; that is, if you enter SMI and SMITH exists, you'll get a match. Another way of saying this is 'implied truncation.' Note that while retrieval on indexed fields is very fast, searching non-indexed fields (e.g., line 3 of the note field) is much slower. On non-indexed fields, BIBL must read each record, comparing your query with the contents of the field. You may abort a non-indexed search by pressing any key to interrupt. -8- On indexed field searches, if BIBL can not find a match for your query, it will display several index entries that come before and after where your query would have fallen in the index. As your database grows, this 'near-miss' display will help you fine-tune your search query. If you want to abandon searching after you have selected a particular field to search, press RETURN instead of entering a search statement at the 'Query >>' prompt. You will be returned to the main menu. Use BOOLEAN search to search for more than 1 term in a record. You may enter only 2 terms and they must be connected by AND or OR or NOT. For example: COMPUTERS and HARDWARE is fine but COMPUTER HARDWARE AND TESTING will work only if the terms COMPUTER HARDWARE appear together in the record. BOOLEAN search *DOES NOT* use any index so searching is somewhat slow, however, it (like full search) does use the Boyer-Moore algorithm which can improve performance up to 200% over a brute force (read each record and compare) search method. PRINTING? Whenever an individual record is displayed during the search function, you may print the record by pressing 'P'. III. EDITING/DELETING RECORDS IN THE DATABASE BIBL allows complete editing of any record in the file. To edit a record, locate the desired record via the Search function. When the record you wish to modify is displayed, press 'E' to enter the EDIT mode. As you first enter EDIT mode, the author's name field will be highlighted. If you want to change that field, enter new information. If you want to edit a different field, press RETURN until the highlighted area is in the field you want to change. When you have finished making changes, press ESC or press RETURN with line 4 of the note field highlighted. You will receive an 'OK to file (y/n)?' prompt. If you respond to the 'OK to File (y/n)?' prompt with: Y - The index file will be updated if your editing has changed an indexed field. N - Any changes made will be discarded. The original record redisplays. -9- You may also enter EDIT mode via the 'List records in the database' option from the main menu. The only difference between editing from this menu choice instead of SEARCH is that BIBL will display all records in the database, beginning with the last record. IV. SYSTEM MAINTENANCE The MAINTENANCE function offers several options: - Convert Shareware to REGISTERED. - Rebuild Indexes - Call External Editor/Call Up Any ASCII files - Shell to DOS - Install Editor/Viewer - UnInstall Editor/Viewer - Make a new database - Delete a database - ASCII Import (Registered Version only) - Global Change A. CONVERT SHAREWARE to REGISTERED. With Release 5.25 we've introduced a new wrinkle, which should prove popular with registered users. Instead of having to obtain a new copy of BIBL with the registered features, you can instantly upgrade the shareware version and 'unlock' the registered features. Here's how it works: When you register, you will receive by return mail a registration number. Select option C under the Maintenance sub-menu, then enter the number EXACTLY as it appears. BIBL will verify that it is a valid number (we do some check-digit math in case you're interested in such things) and will then create an ASCII file (BIBL.REG) which stores that number. From then on, when BIBL activates from the DOS prompt, it will read that file, verify the number, and present you the user with a registered version of the program. The real value is that forever more you can upgrade any SHAREWARE release to REGISTERED, just by entering your secret number. Actually, as long as you leave BIBL.REG in your BIBL sub-directory, the upgrade process will be automatic. You won't have to check our BBS for the latest registered version or have to send us a disk or pay the extra $ 4.00 to receive one by return mail. If you see a newer shareware version on a BBS, you can download it and immediately have the benefits of a new registered version. -10- B. REBUILDING INDEXES We include an index rebuild function to create new indexes from the database file on demand. You may never need this function, but if add records through the ASCII import function; take a power hit during data entry, or experience some other sort of hardware (disk) failure, the index can become invalid or corrupted. Rebuilding indexes will correct any problems of this sort. When rebuilding the indexes, BIBL provides a graph which shows the status of the effort (0%-100% complete for each index). If you have fewer than 50 records, the blocks in the graph represent each record. You may also permanently purge deleted records from your file during the Rebuild Index function. If you answer "Y", the following steps occur: 1. Original database is renamed *.SAV (was *.DAT). A new empty database with the *.DAT extension is created. Note: Should you experience a hardware failure during the purge (for example, losing power on your PC), rename XXXXX.SAV to XXXXX.DAT and run BRX. 2. A new fileblock (database and index) are created. Records are read from the *.SAV file and those not marked for deletion are copied to the new (*.DAT) file. 3. Some preliminary indexing occurs on the new file. 4. New file / index block closed. If copy of new records was successful, the *.SAV file is then erased. If you experience SERIOUS problems with your database, run the utility program BIBL5RX...which rebuilds both the datafile and the indexes. C. CALL EXTERNAL EDITOR/CALL UP ASCII FILE You may view your savefile (QUERY.TXT) or any other ASCII file from within BIBL. The viewer built into BIBL is quite powerful. It responds to a mouse with the following options: Click on small box in upper left..........................closes window. Click on scroll bars..............................move through the file. Click on [arrow] in upper right corner......ZOOMs window to full-screen. Click on top line of window ..................move window around screen. Click on lower right corner, then drag...................resizes window. -11- Keyboard commands: F5 Zoom the view window to fill the screen. F5 a second time to restore original size. ALT-F5 Resize the window (Press ALT-F5 then with the cursor keys size the window until it meets your needs, then press RETURN. CTRL-F5 Move the window. Press CTRL-F5 then move the window with the cursor arrow keys. Press RETURN when done PgUp/PgDn Move up and down a screen at the time. CTRL PgUp/PgDn Move to the top or bottom of the document ESC or F10 Close the window and return to BIBL. If you have an external program linked to BIBL, that program is called and passed the name of the file you want to view. D. SHELL TO DOS BIBL allows you to drop out of the program momentarily and return to your DOS prompt. This option allows you to delete files, use a program like LIST to view a file, check disk space, or do other DOS-type things. BIBL provides a special prompt to remind you to enter EXIT to return to the program. When you type EXIT, BIBL will reactivate and check to see that the operating system is still defaulting to the sub-directory where your BIBL files are kept. If not, BIBL will change to that drive and directory before continuing. If BIBL is unable to change to the original sub-directory, you will receive a message to that effect...so you can manually issue the command (e.g., CD\BIBL <cr>) from the DOS prompt. E. INSTALL EDITOR/VIEWER BIBL allows you to specify some program other than BIBL to handle viewing of your save file or other text files. If you elect to use this option, you should select a program that is small (like the widely-available shareware file-viewer LIST (LIST.COM)). Whichever program you choose, it will have to run in the amount of memory left over after BIBL is loaded. So unless you have the registered version, don't bother trying to use WordPerfect. Also, the program you use must be capable of accepting a file name as a command line argument, e.g., LIST filename <cr> BIBL will send the name of your external program (drive, path, program name and extension) to DOS as well as the name of the file (drive, path, filename, and extension). This allows you to access an external program on another drive if desired. -12- BIBL creates a simple configuration file (BIBL.CFG) when an external viewer/editor is defined. If you want to remove the editor/viewer altogether, just delete the BIBL.CFG file. If you later install another package, BIBL will create the configuration file again. If BIBL encounters a problem (too little memory, invalid name for the viewer/editor program, viewer/editor not found in path, etc.), it will just ignore the request and return to the main menu. [R] The Registered version of BIBL goes an extra step to [R] increase your flexibility in installing an editor/viewer. In [R] addition to compressing the memory heap (as in the Shareware [R] version), BIBL also swaps most of itself out to disk (or EMS [R] if available), freeing up a great deal more system memory your [R] editor/viewer. EMS will be automatically detected and used if [R] available, otherwise the swap is to disk. While the program [R] normally requires 350K or more to run, after compressing [R] itself and swapping out, only a 55-65K kernel of BIBL remains [R] in memory--enabling you to use a very large program (e.g., [R] WordPerfect) as your editor/viewer. When the external program [R] finishes, BIBL returns! F. MAKE A NEW DATABASE. To create a new, empty database, press M on the maintenance menu, then enter a name for the database file. You may enter up to 8 letters for your database name. You should try to give the file a name that will later give some indication of the file's contents. TIP: When creating databases, give your most popular file a name that sorts first. The Database Selection option on the main menu sorts the various *.DAT files before displaying them. The first file in the list will be highlighted when the list displays. If it is the file you want, just press RETURN. G. DELETE A DATABASE. You may use this function to delete a database and it's associated index file. You may also delete a database and index by simple using the DOS delete command while at the DOS prompt. BIBL dynamically determines your databases by scanning the directory where BIBL.EXE resides for files ending with the *.DAT extension. -13- H. ASCII Import Using the ASCII import option enables you to read any labelled ASCII file into the currently active BIBL database. The file must follow this format: ** A1: Shah, Idries T1: Wisdom of the Idiots PB: New York: Putnam and Sons, 1971. (c) 1969 179 pages. CL: book SU: Philosophy DE: Sufi Islam Teaching-stories Dervishes N1: Another in a series by Shah (The Way of the Sufi, Tales of the N2: Dervishes, The Dermis Probe, and The Pleasantries of the Incredible N3: Mulla Nasrudin) where sufi teaching stories are collected. The sufis N4: call themselves 'idiots' in contrast to the many self-styled 'wise.' N5: By chance, the Arabic word for 'Saint' (wali) has the same numerical N6: equivalent as the word for 'Idiot' (balid). Excellent book. ** Where each record is separated with **'s and each line is labelled. The labelled option under the Export Menu creates this format as does the Transfer option when displaying an individual record. If you want to experiment with ASCII import (say you're trying to import an ASCII file from some other source--like bibliographic data downloaded from a CD-ROM), you should follow these steps: 1. Use MAKE A NEW DATABASE option on maintenance menu to create a database called something like TEST 2. Use DATABASE SELECTION on the main menu to select the TEST database. 3. Run ASCII import from the maintenance menu. You BIX file must be in the same subdirectory where BIBL.EXE resides. 4. After reviewing the results (the records added to TEST), select the database you want to use and run ASCII import again. Once that's finished, you can delete TEST.DAT and TEST.IX from the maintenance menu (Delete a Database). -14- I. GLOBAL CHANGE With release 5.34A, you may now make global changes ('find & replace') to text in any record across your database. The SHAREWARE version is limited to making these global changes on the Subject and/or Classification fields. The REGISTERED version of the program will allow you to change text in any field of all records in a given database. To make a global find and replacement, select the field you want to modify (the database will be the currently active file--the database that displays on the status bar at the bottom of your screen). After selecting the field to modify, you must next enter the original text (what's currently in the record(s)) and then the new text. In both situations (the finding and the replacing) the case of the text you enter is significant and your 'find' input must match the database exactly. Be advised that every occurrence of the text you seek in a given field will be changed wherever it appears. This can be a real nightmare if you elect to change a short word--one that also appears as part of a larger word in the same field. If you ask to change NETWORK to LAN and you also have the term NETWORKING in the same field, you'll end up with LANWORKING for NETWORKING! You are not limited to whole word changes (if the text you enter happens to match a few letters inside another word in that field, it will be changed. Again, think your change through before you begin. It is possible that the length of your replacement term(s) will force the truncation of the field. For example, if your descriptor field is presently 60 characters and you change one 5 letter word to a 15 letter word, the field would now be 75 characters long... so the last 5 characters of your field after the 5 letter word becomes a 15 letter one will be chopped off. -14a- V. OUTPUT OPTIONS / REPORTS / BIBLIOGRAPHIES While BIBL offers only limited print support, it will dump your database to disk in an ASCII file--which you can then edit and print using your favorite word processor. Blank fields do not appear in the ASCII files BIBL can create (the exception being DELIMITED format). You may select Author, Title, Subject, Delimited or the order records appear in the database. Note that each time you call the dump to disk routine it overwrites any previously created file. Here is a list of the files created via the Export function. Where you are given the option of naming the file, you should use a *.TXT extension when possible. This will allow you to see all available export files under the CALL EXTERNAL EDITOR function when you accept the default *.TXT mask. Content Name BIBL will give ASCII file Author AUTHLIST.TXT (sorted by author, then title) Title TITLLIST.TXT Subject SUBJLIST.TXT Delimited BIBLDLM.TXT Labelled BIBLLIST.BIX You may assign names to these files...and include a pathname if desired. For example, to put the file on a floppy, preceed the name with A: (e.g.,A:MYFILE.TXT). Bibliographies User names this file. Registered version also offers option of using SOFT RETURNS. [Index View/Dump] Keyword List KEYWORD.TXT (user can rename) Extract Titles (Title+Author) TIBRIEF.TXT List of Subjects (Subj+Title) SUBRIEF.TXT List of Authors (Author+Title) AUBRIEF.TXT Other 1/2/4 (Author/Title/Class) ATCLIST.TXT 4/1/2 (Class/Author/Title) CATLIST.TXT User-Defined User names this file. WP format (soft returns) available. -15- Here is a sample of the ATCLIST.TXT file...note that fields will be truncated in this and the CATLIST file: Author Title Class Bevilacqua, Ann F. Hypertext: Behind the Hype. article Boswell, Thomas The Heart of the Order book Brandt, Scott Authority Files for Microcomputer article Bratley, Paul and Choue Processing Truncated Terms in Doc Box 3,Folder 9 Byrne, Alex and Mary Mi Improving OPAC Subject Access: Th Box 4,Folder 2 Carroll, David M. And O Bibliographic Pattern Matching Us article BIBLIOGRAPHIES A rudimentary bibliography generator, BIBL will create ASCII text files (in full record, annotated, or brief form) for all records that contain your search string. [R] The registered version also supports LABELLED output of bibliographies. [R] Using this feature and the ASCII Import option on the Maintenance menu, [R] you can select out records from one database based on text that appears [R] in a given field, then use ASCII Import to read those records into [R] another database. This gives you an 'automatic' means of moving records [R] from one database to another. You tell BIBL what field you want to search, and what text you seek. BIBL then produces an ASCII file of all records that contain the text you entered. [R] Registered version supports bibliography creation on ANY field [R] in the record. The registered version of BIBL also provides the [R] option to create output files using soft returns (instead of [R] hard ASCII returns) after each line. This greatly simplifies [R] subsequent editing if using a word processor that supports a [R] variety of fonts. Annotated form will produce a listing with author, title, publisher and the notes fields. Brief includes only the author, title, and publisher field. Below, a sample 'annotated' reference appears: Bratley, Paul and Choueka, Yaacov Processing Truncated Terms in Document Retrieval Systems. Information Processing and Management v18 n5 p257-66 1982 Presents uniform and efficient approach for processing all truncated query terms in information retrieval which requires one disk access to obtain from the permuted dictionary all strings represented by truncated term. The problem of the overhead storage required to implement the permuted dictionary is discussed. Fifteen references. -16- You assign the name for the bibliography output file. If the name is already in use, BIBL asks you to use another name. Note that using the Word Processing [WP] format option will produce a citation where fields follow one another on a line. A hard return follows the PUBL field. Bratley, Paul and Choueka, Yaacov. Processing Truncated Terms in Document Retrieval Systems. Information Processing and Management. v18 n5 p257-66. 1982. 'Smart' Punctuation [WP format] [R] As BIBL creates your bibliography, it will check to see whether [R] each field ends with punctuation. If so, the existing [R] punctuation will be written to your output file. If not, BIBL [R] will add periods after each field. This saves you having to [R] use end-of-field punctuation in your BIBL database entry. DELIMITED FORMAT Delimited format is used when you want to move your BIBL database to dBASE or some other database system. The next few paragraphs point out a few things you should be aware of: Note that in delimited format BIBL will change any quotation mark that appears in the Title, Descriptor, or Note fields to a single quote--to preserve the exported data's integrity. If any double quotes were to appear in the exported data (that is, anywhere other than between the fields), the the importing program might not process the data correctly. For example, if you have: Jones is author of the article, "This is My Life's Work." in your note field, under delimited format, BIBL will export: "Jones is author of the article, 'This is My Life's Work.'" A CR/LF appears at the end of each record. dBASE will accept this for input if you first set up a dBASE file with the proper structure. Use the field lengths as they appear at the end of this documentation. With the database structure created activate dBASE and issue the following command: . USE MYBOOKS <cr> . APPEND FROM BIBLDLM.TXT DELIM <cr> -17- LIST SUBJECTS/LIST DESCRIPTORS (Keywords) You should use these export functions periodically to check the uniformity of your subject headings and descriptor fields. For example, if your list shows you have 10 items under computer and 1 under computers, you should edit the COMPUTERS entry (changing it to COMPUTER). As an aid in helping you identify the records, a bit of the title is included with each entry. Note that there is an entry in the list for each heading in a record (if you have 10 records with the subject BASEBALL, you'll get 10 entries for BASEBALL in the SUBJECTS.TXT file). KEYWORD.TXT - this option lists all terms used in the descriptor field of your database. With each term, the number of times it appears is also listed. This list can be a big help in eliminating redundant terms and consolidating similar terms to yield a stronger database. Related Topics Send To Disk. Beyond creating large reports, during any search you may elect to send a copy of a single record to an ASCII file (QUERY.TXT). Each time you press 'S' a copy is appended to this file. When you are finished with the file, delete it (via DOS) or rename it. Then when you next send a record to disk, BIBL will create a new copy of QUERY.TXT. Transfer: Any time an individual record is displayed, you have the option of copying it to a transfer file (TRANSFER.BIX). Pressing T (or clicking on the word 'Transfer' will add the record to TRANSFER.BIX. To move the records in TRANSFER.BIX use ASCII import on the maintenance menu. [R] Registered users can also transfer records in groups, based on text [R] occurring in any field. Select Bibliographies/Transfer on the Export [R] menu, then proceed as you would when creating a bibliography. When [R] prompted for output format, select Labelled. You will next be asked [R] if you want to delete transferred records from your original file. [R] You may want to run this option once before you go back and ask BIBL [R] to delete copied records (just to verify that you did retrieve the [R] records you wanted AND to insure that you were able to import them [R] to another database successfully). -18- IMPORTANT [R] Once you ask BIBL to delete these records, they will be permanently [R] gone...deleted from the original database which will then be [R] packed and re-indexed before returning to the Main Menu! USAGE NOTES / TIPS The following section covers a few uses for BIBL then focuses particular attention on using BIBL with WordPerfect. A. What some other users are doing with BIBL: - maintain an online index to your personal book collection. - track magazine articles you read and want to remember. - in a library, BIBL can be used to provide an index of your vertical file (for non-library types, a vertical file is usually a filing cabinet of clippings, brochures, and the like). - use BIBL instead of 3x5 cards for research. When you're done, it can create a bibliography for you. - keep track of reserve reading materials. The '/P' (OPAC) switch is nice here, since other users can only read your database. - Manage your office library. If you have branches, send them a copy of BIBL.EXE and your *.DAT and *.IX file. They can use the SEND TO DISK option to create a list of materials they'd like you to send to the branch. B. Using WordPefect (5.0 or 5.1) as your external editor (or viewer or printer) with REGISTERED version of BIBL While BIBL does not possess a direct interface to WordPerfect it does work particularly well with that word processor. Follow the sequence below to install WordPerfect as your external editor. Note: the sequence is the same for any word-processor...just be sure that the program accepts a filename to edit on the command line (e.g., WP MYFILE [RETURN] on the DOS command line will start WordPerfect and load a file named MYFILE). WordStar also behaves this way as do other programs. 1. Select MAINTENANCE from the BIBL main menu (press M) 2. Press I (Install Editor/Viewer). 3. Enter the full path name to your copy of WP.EXE (e.g., C:\WP51\WP.EXE). Now, when you select CALL UP ASCII FILE under the MAINTENANCE option, BIBL will load WordPerfect and pass along the name of the file you want to view, edit or print. When you are finished with the document, press F7 to save and then exit WordPerfect...you will be returned to BIBL. The file you worked on is stored on the drive and sub-directory where BIBL.EXE resides. -19- C. Remote Drives / LAN usage (registered version only). With release 5.32, you may store your database and index files on a drive/sub-directory other than were the BIBL.EXE file is kept. This will allow you to use BIBL on a LAN or in an environment where disk drives are shared between users. While BIBL is still a single user product (network version of BIBL is tentatively scheduled for release in early 1992), you can store your database and index on the server disk. To point BIBL to some location other than the drive/directory where BIBL.EXE resides, you must create a configuration file. Name of file: BIBLPATH.CFG Location: Must reside in same directory as BIBL.EXE Purpose: When BIBL first initializes, if it finds BIBLPATH.CFG it opens the file and reads the data path statement. That path then is added to all subsequent database access calls. Format: ASCII text file that contains the following statement: DATAPATH=X:\XXXXX where X:\XXXXX is the full path name of the subdirectory you want to use for storing BIBL databases and index files. Example: Suppose you store BIBL.EXE in your C:\BIBL subdirectory, and you want to put your datafiles and indexes on the fileserver (say, drive H:) and in a special subdirectory reserved for your use (e.g., MYFILES\BIBL). Create BIBLPATH.CFG and enter this statement: DATAPATH=H:\MYFILES\BIBL You do not need to put a '\' on the end of the line. To make: You can use an ASCII editor (e.g., QEDIT) or simply create the file from the DOS prompt. Here is how you create the file using only DOS: 1) Log onto the subdirectory where BIBL.EXE resides 2) At the DOS prompt, type the following lines. Use UPPER CASE for DATAPATH=. ([CR] means press RETURN. [F6] means press F6. COPY CON: BIBLPATH.CFG[CR] DATAPATH=X:\XXXXXX[CR] [F6] -20- D. Using WordPerfect with the SHAREWARE version of BIBL. While WordPerfect is too large to use as an external editor, the [WP] format option (which uses soft returns) is still very useful with WordPerfect. The [WP] format option is available under option [M] (User-Selects) of the EXPORT menu (and for registered users, under option [D] (Bibliographies) as well). E. Using BIBL's [WP] format with WordPefect. Here is how you could create a WordPerfect-ready version of your database, (printing author, title and publisher fields), sorted by Author, then title: 1. Press E on the BIBL main menu (EXPORT). 2. Press M (user-selects). 3. Answer 'Y' that you want to continue. 4. Enter 123 and press return (to indicate that you want fields one (author), two (title) and three (publisher). 5. Enter 'Y' to indicate that you're satisfied with these fields. 6. Enter 1 to indicate that sort should be on author (it will actually be on author, then title within author). 7. Enter 'E' to indicate that you want [WP] format. 8. Enter the name you want to give your output file. If you are using the SHAREWARE version of BIBL, quit the program, copy the file you just created to your WordPerfect sub-directory, then type WP xxxx.xx (where xxxx.xx is your file) at the DOS prompt. [R] If you are using the REGISTERED VERSION and have installed WordPerfect [R] as your External Editor, once BIBL finishes making your file and returns [R] to the main menu, press M (for Maintenance), Then press C to 'CALL [R] External Editor, enter the name you gave the file in step 8 (or just [R] hit return and pick from the *.TXT files displayed), then sit back as [R] BIBL compresses itself, then loads WordPerfect (passing along the [R] name of your file). If you need to reset your margins (because the text is wrapping around incorrectly), go to the top of the document and press SHIFT-F8, then L (for Line), then M for margins. F. Modifying HELP display (INFORMATION on the main menu). BIBL displays the file BIBL.HLP when 'I' is pressed on the Main Menu. If you want to change the help display file, just rename any ASCII file to BIBL.HLP and BIBL will display it... Be sure to make a backup copy of this documentation file before you use the name on another file! -21- G. BACKUP? Many users have found that using the LABELLED option under Export provides a space-saving means of making a backup copy of your database(s). Since only the data from your database is exported (not the empty spaces inside each record), the resulting file is usually about 40% smaller than your database. With ASCII Import (on Maintenance menu of registered version) or BIBL5IN (a standalone utility), you can read this file back into BIBL should you ever need to reconstitute your database. With 5.41 another option has been introduced. You may use BIBL to 'drive' any one of three third-party archiving utility programs (LHA.EXE - .LZH files; PKZIP.EXE - .ZIP files, and ARJ.EXE - .ARJ files). The archiving program *MUST* be either in your BIBL subdirectory or in a sub-directory that is included in your DOS path statement. If the archiving program is not found, BIBL will ignore the request. If it is found, BIBL compresses itself in memory (down to about 91K), then launches the archiving program. When it is finished, BIBL reexpands in memory and continues running. If you have EMS memory, BIBL will swap itself to EMS during this process (otherwise, it swaps to disk). Both the data file (*.DAT) and the index file (*.IX) are combined in the archive you create. Since BIBL always initializes both records and index entries with 0's before use, these programs achieve a compression of 85 - 90%! Thus, you can probably fit a 2,000 record database (and index) on a 360K floppy. Technical Specs: 1. Memory required. BIBL requires a minimum of 330 RAM to operate. If you have more, then more will be available when you Shell to DOS, and to load an external program. [R] Additional RAM (beyond 330K) will also improve performance [R] of the Registered Version of the program. BIBL will use [R] 40% of available RAM after 330K for in-memory index storage. [R] This will speed retrieval, re-indexing, etc. 2. Using dBASE (structure of record) dBASE structure for a BIBL record (use this to set up a dBASE file which you will then append to using BIBL's 'delimited' export function). You may call your fields anything you like but they must be this length, and in this order: Fieldname Length Type AUTHOR1 70 C AUTHOR2 70 C TITLE1 70 C TITLE2 70 C TITLE3 70 C PUBLISHER 70 C PUBL2 70 C CLASS 40 C SUBJECT 30 C DESC 70 C flag1 1 C flag2 1 C flag3 1 C value 7 C NOTE1 70 C NOTE2 70 C NOTE3 70 C NOTE4 70 C NOTE5 70 C NOTE6 70 C NOTE7 70 C -22- PASCAL structure for a BIBL record: bookrec = RECORD recordstatus : longint; author1 : string[70]; author2 : string[70]; Title1 : string[70]; title2 : STRING[70]; title3 : string[70]; publ : STRING[70]; publ2 : string[70]; class : STRING[40]; subject1 : string[30]; subject2 : STRING[70]; {descriptor field} flag1 : char; flag2 : char; flag3 : char; value : string[7]; note1 : STRING[70]; note2 : STRING[70]; note3 : STRING[70]; note4 : STRING[70]; note5 : STRING[70]; note6 : STRING[70]; note7 : string[70]; END; Indexes (the following keys are maintained in each .IX file): Author - first 20 characters of the field (stored upper case) Title - first 25 characters of the field (stored upper case) Subject - all 30 characters of the subject1 field (stored upper case) Descriptor - first each word of the field is extracted (a word being a string of characters separated by a space or comma). Up to 20 characters of each 'word' is indexed. Up to 8 words from any one line are indexed. If you have 9 words on the line, the ninth is ignored. IMPORTANT: place a '-' between words you want BIBL to treat as a single entry. A fifth index is reserved for 'on-the-fly' reports (bibliographies, sort on publisher or class field, etc). Data stored in this index is compressed (to allow larger text values to be represented. The key length is 15 characters although with data compression, 20 characters are used to build the key). During bibliography production (Option D on Export Menu), the key value for this fifth index is: author(14 characters)+title (6 characters) which yields an author/title sort. During User-Defined output (Option M on Export Menu), with a sort on the CLASS field (field #4), the sort key is class(15 characters)+ author(5 characters), to yield a class/author sort. -23- If publisher field sort is selected for Option M, then 20 characters of the publisher field are used to generate the key. File Extensions used by BIBL: .DAT - a datafile .IX - the index to a DAT datafile. The *.DAT and *.IX files together form 'a database.' You must have the same name on both you .DAT and .IX files--usually taken care of by BIBL but if you rename a database via DOS (for example, renaming DEMO.DAT to MYFILE.DAT, be sure to rename DEMO.IX to MYFILE.IX too!). .TXT - any ASCII file. .BIX - a labelled ASCII file. This file uses a specific format where each field is labelled (e.g., A1:, A2: for the 2 author fields, T1: T2: T3: for the title fields, and so on. Each record in the file is separated by '**'. The ASCII import function on the Maintenance Menu (registered version only) will read a BIX file and write the information to BIBL records. You can thus use this facility for backing up your database or moving records from one file to another. Here is a sample record in BIX format: ** A1: Bratley, Paul and Choueka, Yaacov T1: Processing Truncated Terms in Document Retrieval Systems. PB: Information Processing and Management. Volume 18, Number 5 P2: pages 276-66. 1982 SU: Information Retrieval DE: Information-Storage Permuted-Indexes Subject-Indexing N1: Presents uniform and efficient approach for processing all truncated N2: query terms in information retrieval which requires one disk access N3: to obtain from the permuted dictionary all strings represented by N4: truncated term. The problem of the overhead storage required to N5: implement the permuted dictionary is discussed. Fifteen references N6: are provided. ** Note: BIBL.EXE has been compressed with PKLITE version 1.13 Questions, comments, complaints, encouragement??? Contact: Clyde W. Grotophorst, Route 1, Box 296, Hamilton, VA 22068 (703) 993-2239 or call the GMUtant OnLine BBS (703) 993-2219, and leave a comment for the Sysop. The Bulletin Board is your source for additional BIBL utilities. Notes: -24- I N D E X *.SAV extension (12) Demo database (3) Adding records (8) Data entry ASCII Import considerations (9) from within BIBL (15) Editing labelled format illustrated (15) overview (10) B5DEMO (5) via LIST option (11) BIBL.REG global changes (14a) contents of (11) Equipment BIBL5.HLP (22) monochrome monitor (6) BIBL5IN (Available from GMUtant BBS) RAM required (23) labelled Bibliographies (17) Export not needed for registered (15) BIBL data to dBASE (18) restoring BACKUP (23) to diskette (16) use with TRANSFER.BIX (19) Export sub-menu BIBLDEMO.EXE annotated bibliography format (7) demonstration database (3) ATCLIST.TXT (sample) (17) Bibliographies/Transfer delimited (use of quotes) (18) (registered version only) (19) general (15) Bibliography Production list of Descriptors (19) labelled format (registered) (17) list of files created (16) smart Punctuation (18) option D (sort explained) (24) word Processing format (18) option M (user-defined) (24) *.BIX File extension explained (24) soft returns in output (17) Bounce-bar menus External Editor how to use (6) BIBL.CFG file (14) CATLIST.TXT (16) command-line arguments (13) CD-ROM installing (14) importing data from (15) swapping BIBL to EMS (14) Classification Field WordPerfect (20) sorting on (export) (9) File Display Windows Command line switches keyboard commands (13) /m (6) mouse Commands (12) /p (6) Find & Replace (Global Change) (14a) /v (6) GMUtant OnLine BBS (25) CONFIG.SYS (5) Help screen - modifying (22) Database Indexes backup (23) described (8) creating new databases (14) technical description (24) editing (10) Indexing searching (9) graph of progress (12) size limits (8) Installation (5) Database structure Keywords (9) classification field (9) Labelled format (15) Databases Main Menu (options summarized) (7) creating a default (14) Maintenance sub-menu deleting a database (14) convert Shareware to Registered (11) DBASE create a new database (14) delimited Export (18) delete a Database (14) structure for BIBL record (23) global Changes (14a) using BIBL database with (23) rebuilding Indexes (12) Memory requirements (RAM) (23) OPAC read-only operation (6) PKLite (24) Printing (10) QUERY.TXT (19) Record Structure dBASE (23) Pascal (24) subject vs descriptor (9) Registration credit cards (2) Removing deleted records (12) Searching (9) boolean (10) display of near-matches (10) implied truncation (9) non-indexed fields (9) Send to Disk (19) Shell to DOS (13) Smart Punctuation (18) Sorting on Classification (24) Transfer (records between databases) (19) WordPerfect use as external editor (20) BIBL REGISTRATION [Release 5.51] Name ___________________________________________________ Address ___________________________________________________ ___________________________________________________ City ____________________ State _____ Zip _________ Country ____________________ How (or where) did you obtain your copy of BIBL? _______________________ Comments on the program: Are you currently a user of GMUtant OnLine BBS? Yes ___ No ___. If not, when you first call, leave a comment to the Sysop, so we can upgrade your security and provide you with access to the registered users portion of our system. BBS #: 703-993-2219 9600(v.32)/2400/1200 24 hours a day When you register, you will be sent a registration number by return mail. With that number, you may 'upgrade' any SHAREWARE version to a REGISTERED version and unlock the extra features. Registration Fees: Basic Registration (includes registered access to GMUtant BBS) $25.00 Site License (15 copies) $200.00 (16-50 copies) $ 50.00 plus $ 10.00 ea (51+ copies) $ 50.00 plus $ 7.00 ea Mailing fee (if you want latest release sent via diskette) $ 4.00 Total enclosed: $ __________ If requesting a diskette, please indicate desired format: ___ 3.50" ___ 5.25" ( ) MasterCard ( ) Visa ( ) American Express ( ) Check/MoneyOrder** ** Checks must be in US Dollars from a US account with an ABA routing number, made payable to: Clyde W. Grotophorst I authorize The Public (Software) Library to debit my AmExp/Mastercard/Visa account: Card Number ____________________________________________________ Name as it appears on card (PRINT) ______________________________ Expiration Date ___________ Signature __________________________ Cash/Money Orders: Credit Card Orders: Clyde W. Grotophorst Public (Software) Library Route 1, Box 296 PO Box 35705 Hamilton, VA 22068 USA Houston, TX 77235-5705 BBS: (703) 993-2219 Orders ONLY: 1 800-242-4775 Fax: 713 524-6398